home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / ImageByteOrder.z / ImageByteOrder
Encoding:
Text File  |  1998-10-30  |  5.0 KB  |  133 lines

  1.  
  2.  
  3.  
  4.      IIIImmmmaaaaggggeeeeBBBByyyytttteeeeOOOOrrrrddddeeeerrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))IIIImmmmaaaaggggeeeeBBBByyyytttteeeeOOOOrrrrddddeeeerrrr((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit,
  10.           DisplayHeight, DisplayHeightMM, DisplayWidth,
  11.           DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues -
  12.           image format functions and macros
  13.  
  14.      SSSSYYYYNNNNTTTTAAAAXXXX
  15.           XPixmapFormatValues *XListPixmapFormats(_d_i_s_p_l_a_y,
  16.           _c_o_u_n_t__r_e_t_u_r_n)
  17.                 Display *_d_i_s_p_l_a_y;
  18.                 int *_c_o_u_n_t__r_e_t_u_r_n;
  19.  
  20.           ImageByteOrder(_d_i_s_p_l_a_y)
  21.  
  22.           BitmapBitOrder(_d_i_s_p_l_a_y)
  23.  
  24.           BitmapPad(_d_i_s_p_l_a_y)
  25.  
  26.           BitmapUnit(_d_i_s_p_l_a_y)
  27.  
  28.           DisplayHeight(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  29.  
  30.           DisplayHeightMM(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  31.  
  32.           DisplayWidth(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  33.  
  34.           DisplayWidthMM(_d_i_s_p_l_a_y, _s_c_r_e_e_n__n_u_m_b_e_r)
  35.  
  36.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  37.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  38.  
  39.           _c_o_u_n_t__r_e_t_u_r_n
  40.                     Returns the number of pixmap formats that are
  41.                     supported by the display.
  42.  
  43.           _s_c_r_e_e_n__n_u_m_b_e_r
  44.                     Specifies the appropriate screen number on the
  45.                     host server.
  46.  
  47.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  48.           The _X_L_i_s_t_P_i_x_m_a_p_F_o_r_m_a_t_s function returns an array of
  49.           _X_P_i_x_m_a_p_F_o_r_m_a_t_V_a_l_u_e_s structures that describe the types of Z
  50.           format images supported by the specified display.  If
  51.           insufficient memory is available, _X_L_i_s_t_P_i_x_m_a_p_F_o_r_m_a_t_s returns
  52.           NULL.  To free the allocated storage for the
  53.           _X_P_i_x_m_a_p_F_o_r_m_a_t_V_a_l_u_e_s structures, use _X_F_r_e_e.
  54.  
  55.           The _I_m_a_g_e_B_y_t_e_O_r_d_e_r macro specifies the required byte order
  56.           for images for each scanline unit in XY format (bitmap) or
  57.           for each pixel value in Z format.
  58.  
  59.           The _B_i_t_m_a_p_B_i_t_O_r_d_e_r macro returns _L_S_B_F_i_r_s_t or _M_S_B_F_i_r_s_t to
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      IIIImmmmaaaaggggeeeeBBBByyyytttteeeeOOOOrrrrddddeeeerrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))IIIImmmmaaaaggggeeeeBBBByyyytttteeeeOOOOrrrrddddeeeerrrr((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           indicate whether the leftmost bit in the bitmap as displayed
  75.           on the screen is the least or most significant bit in the
  76.           unit.
  77.  
  78.           The _B_i_t_m_a_p_P_a_d macro returns the number of bits that each
  79.           scanline must be padded.
  80.  
  81.           The _B_i_t_m_a_p_U_n_i_t macro returns the size of a bitmap's scanline
  82.           unit in bits.
  83.  
  84.           The _D_i_s_p_l_a_y_H_e_i_g_h_t macro returns the height of the specified
  85.           screen in pixels.
  86.  
  87.           The _D_i_s_p_l_a_y_H_e_i_g_h_t_M_M macro returns the height of the
  88.           specified screen in millimeters.
  89.  
  90.           The _D_i_s_p_l_a_y_W_i_d_t_h macro returns the width of the screen in
  91.           pixels.
  92.  
  93.           The _D_i_s_p_l_a_y_W_i_d_t_h_M_M macro returns the width of the specified
  94.           screen in millimeters.
  95.  
  96.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  97.           The _X_P_i_x_m_a_p_F_o_r_m_a_t_V_a_l_u_e_s structure provides an interface to
  98.           the pixmap format information that is returned at the time
  99.           of a connection setup.  It contains:
  100.           typedef struct {
  101.                int depth;
  102.                int bits_per_pixel;
  103.                int scanline_pad;
  104.           } XPixmapFormatValues;
  105.  
  106.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  107.           AllPlanes(3X11), BlackPixelOfScreen(3X11),
  108.           IsCursorKey(3X11), XFree(3X11)
  109.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.